Add some (but not all) docs for the Rust crate #696
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We're not yet complete, but it's a start.
8 tasks
gadomski
commented
Aug 13, 2024
| @@ -155,6 +155,7 @@ bench = false # TODO fix this benchmark | |||
| required-features = ["parquet_compression"] | |||
|
|
|||
| [package.metadata.docs.rs] | |||
| rustdoc-args = ["--cfg", "docsrs"] | |||
There was a problem hiding this comment.
To see what this gets us, you can run:
RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features -F gdal/bindgenThat will get us feature flags in the output, which is how docs.rs presents stuff. E.g. on the io mod:
There was a problem hiding this comment.
Oh I've been wondering how to get the feature flag badges in the docs! That looks great!
kylebarron
approved these changes
Aug 13, 2024
Co-authored-by: Kyle Barron <[email protected]>
Co-authored-by: Kyle Barron <[email protected]>
Co-authored-by: Kyle Barron <[email protected]>
|
As a general note, as I was adding |
Co-authored-by: Kyle Barron <[email protected]>
Co-authored-by: Kyle Barron <[email protected]>
Co-authored-by: Kyle Barron <[email protected]>
Co-authored-by: Kyle Barron <[email protected]>
Co-authored-by: Kyle Barron <[email protected]>
Closed
gadomski
force-pushed
the
issues/689-docs
branch
from
24a4a8c to
39805e9
Compare
gadomski
force-pushed
the
issues/689-docs
branch
from
39805e9 to
5cd0e76
Compare
|
Thanks! |
kylebarron
pushed a commit
that referenced
this pull request
Aug 23, 2024
If it's ok, I'd be stoked to get a v0.3.0 release of **geoarrow** — some of my **stac-geoparquet** is getting close to being release-able. Here's a checklist of things that have been mentioned as part of a v0.3 (including #628 (comment) and https://github.com/geoarrow/geoarrow-rs/milestone/3): - #660 is done ✅ - Some (but not all) of the doc updates are done in #696, and I've got a tracking issue for the rest in #689 - "Broader support for 3d geometries" isn't done as far as I know, but I haven't really been touching that at all yet - #539 is a Python thing, not a Rust crate thing As a part of this release PR I've updated our deps when possible (`sqlx` will require code change to support an update so I haven't done that one).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Includes:
Table::from_arrow_and_geometryto make the argument order the same asTable::try_newdbg!statement in src/array/coord/separated/array.rsmod-name/mod.rsmodules up a level (table.rsandchunked_array.rs)#![deny(missing_docs)]tolib.rs, and then#![allow(missing_docs)]on the "deep" modules (e.g.algorithm,array)NB I've updated #689 with a checklist to track progress on the "deep" modules